<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="retail_v2alpha.html">Vertex AI Search for commerce API</a> . <a href="retail_v2alpha.projects.html">projects</a> . <a href="retail_v2alpha.projects.locations.html">locations</a> . <a href="retail_v2alpha.projects.locations.catalogs.html">catalogs</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="retail_v2alpha.projects.locations.catalogs.attributesConfig.html">attributesConfig()</a></code>
</p>
<p class="firstline">Returns the attributesConfig Resource.</p>

<p class="toc_element">
  <code><a href="retail_v2alpha.projects.locations.catalogs.branches.html">branches()</a></code>
</p>
<p class="firstline">Returns the branches Resource.</p>

<p class="toc_element">
  <code><a href="retail_v2alpha.projects.locations.catalogs.completionData.html">completionData()</a></code>
</p>
<p class="firstline">Returns the completionData Resource.</p>

<p class="toc_element">
  <code><a href="retail_v2alpha.projects.locations.catalogs.controls.html">controls()</a></code>
</p>
<p class="firstline">Returns the controls Resource.</p>

<p class="toc_element">
  <code><a href="retail_v2alpha.projects.locations.catalogs.generativeQuestion.html">generativeQuestion()</a></code>
</p>
<p class="firstline">Returns the generativeQuestion Resource.</p>

<p class="toc_element">
  <code><a href="retail_v2alpha.projects.locations.catalogs.generativeQuestions.html">generativeQuestions()</a></code>
</p>
<p class="firstline">Returns the generativeQuestions Resource.</p>

<p class="toc_element">
  <code><a href="retail_v2alpha.projects.locations.catalogs.merchantCenterAccountLinks.html">merchantCenterAccountLinks()</a></code>
</p>
<p class="firstline">Returns the merchantCenterAccountLinks Resource.</p>

<p class="toc_element">
  <code><a href="retail_v2alpha.projects.locations.catalogs.models.html">models()</a></code>
</p>
<p class="firstline">Returns the models Resource.</p>

<p class="toc_element">
  <code><a href="retail_v2alpha.projects.locations.catalogs.operations.html">operations()</a></code>
</p>
<p class="firstline">Returns the operations Resource.</p>

<p class="toc_element">
  <code><a href="retail_v2alpha.projects.locations.catalogs.placements.html">placements()</a></code>
</p>
<p class="firstline">Returns the placements Resource.</p>

<p class="toc_element">
  <code><a href="retail_v2alpha.projects.locations.catalogs.servingConfigs.html">servingConfigs()</a></code>
</p>
<p class="firstline">Returns the servingConfigs Resource.</p>

<p class="toc_element">
  <code><a href="retail_v2alpha.projects.locations.catalogs.userEvents.html">userEvents()</a></code>
</p>
<p class="firstline">Returns the userEvents Resource.</p>

<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#completeQuery">completeQuery(catalog, dataset=None, deviceType=None, enableAttributeSuggestions=None, entity=None, languageCodes=None, maxSuggestions=None, query=None, visitorId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Completes the specified prefix with keyword suggestions. This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.</p>
<p class="toc_element">
  <code><a href="#exportAnalyticsMetrics">exportAnalyticsMetrics(catalog, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Exports analytics metrics. `Operation.response` is of type `ExportAnalyticsMetricsResponse`. `Operation.metadata` is of type `ExportMetadata`.</p>
<p class="toc_element">
  <code><a href="#getAttributesConfig">getAttributesConfig(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets an AttributesConfig.</p>
<p class="toc_element">
  <code><a href="#getCompletionConfig">getCompletionConfig(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a CompletionConfig.</p>
<p class="toc_element">
  <code><a href="#getConversationalSearchCustomizationConfig">getConversationalSearchCustomizationConfig(name, x__xgafv=None)</a></code></p>
<p class="firstline">Returns the conversational search customization config for a given catalog.</p>
<p class="toc_element">
  <code><a href="#getDefaultBranch">getDefaultBranch(catalog, x__xgafv=None)</a></code></p>
<p class="firstline">Get which branch is currently default branch set by CatalogService.SetDefaultBranch method under a specified parent catalog.</p>
<p class="toc_element">
  <code><a href="#getGenerativeQuestionFeature">getGenerativeQuestionFeature(catalog, x__xgafv=None)</a></code></p>
<p class="firstline">Manages overal generative question feature state -- enables toggling feature on and off.</p>
<p class="toc_element">
  <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all the Catalogs associated with the project.</p>
<p class="toc_element">
  <code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
  <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the Catalogs.</p>
<p class="toc_element">
  <code><a href="#setDefaultBranch">setDefaultBranch(catalog, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Set a specified branch id as default branch. API methods such as SearchService.Search, ProductService.GetProduct, ProductService.ListProducts will treat requests using "default_branch" to the actual branch id set as default. For example, if `projects/*/locations/*/catalogs/*/branches/1` is set as default, setting SearchRequest.branch to `projects/*/locations/*/catalogs/*/branches/default_branch` is equivalent to setting SearchRequest.branch to `projects/*/locations/*/catalogs/*/branches/1`. Using multiple branches can be useful when developers would like to have a staging branch to test and verify for future usage. When it becomes ready, developers switch on the staging branch using this API while keeping using `projects/*/locations/*/catalogs/*/branches/default_branch` as SearchRequest.branch to route the traffic to this staging branch. CAUTION: If you have live predict/search traffic, switching the default branch could potentially cause outages if the ID space of the new branch is very different from the old one. More specifically: * PredictionService will only return product IDs from branch {newBranch}. * SearchService will only return product IDs from branch {newBranch} (if branch is not explicitly set). * UserEventService will only join events with products from branch {newBranch}.</p>
<p class="toc_element">
  <code><a href="#updateAttributesConfig">updateAttributesConfig(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the AttributesConfig. The catalog attributes in the request will be updated in the catalog, or inserted if they do not exist. Existing catalog attributes not included in the request will remain unchanged. Attributes that are assigned to products, but do not exist at the catalog level, are always included in the response. The product attribute is assigned default values for missing catalog attribute fields, e.g., searchable and dynamic facetable options.</p>
<p class="toc_element">
  <code><a href="#updateCompletionConfig">updateCompletionConfig(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the CompletionConfigs.</p>
<p class="toc_element">
  <code><a href="#updateConversationalSearchCustomizationConfig">updateConversationalSearchCustomizationConfig(catalog, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the conversational search customization config for a given catalog.</p>
<p class="toc_element">
  <code><a href="#updateGenerativeQuestion">updateGenerativeQuestion(catalog, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Allows management of individual questions.</p>
<p class="toc_element">
  <code><a href="#updateGenerativeQuestionFeature">updateGenerativeQuestionFeature(catalog, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Manages overal generative question feature state -- enables toggling feature on and off.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="completeQuery">completeQuery(catalog, dataset=None, deviceType=None, enableAttributeSuggestions=None, entity=None, languageCodes=None, maxSuggestions=None, query=None, visitorId=None, x__xgafv=None)</code>
  <pre>Completes the specified prefix with keyword suggestions. This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.

Args:
  catalog: string, Required. Catalog for which the completion is performed. Full resource name of catalog, such as `projects/*/locations/global/catalogs/default_catalog`. (required)
  dataset: string, Determines which dataset to use for fetching completion. &quot;user-data&quot; will use the dataset imported through CompletionService.ImportCompletionData. `cloud-retail` will use the dataset generated by Cloud Retail based on user events. If left empty, completions will be fetched from the `user-data` dataset. Current supported values: * user-data * cloud-retail: This option requires enabling auto-learning function first. See [guidelines](https://cloud.google.com/retail/docs/completion-overview#generated-completion-dataset).
  deviceType: string, The device type context for completion suggestions. We recommend that you leave this field empty. It can apply different suggestions on different device types, e.g. `DESKTOP`, `MOBILE`. If it is empty, the suggestions are across all device types. Supported formats: * `UNKNOWN_DEVICE_TYPE` * `DESKTOP` * `MOBILE` * A customized string starts with `OTHER_`, e.g. `OTHER_IPHONE`.
  enableAttributeSuggestions: boolean, If true, attribute suggestions are enabled and provided in the response. This field is only available for the `cloud-retail` dataset.
  entity: string, The entity for customers who run multiple entities, domains, sites, or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. If this is set, it must be an exact match with UserEvent.entity to get per-entity autocomplete results. This field will be applied to `completion_results` only. It has no effect on the `attribute_results`. Also, this entity should be limited to 256 characters, if too long, it will be truncated to 256 characters in both generation and serving time, and may lead to mis-match. To ensure it works, please set the entity with string within 256 characters.
  languageCodes: string, Note that this field applies for `user-data` dataset only. For requests with `cloud-retail` dataset, setting this field has no effect. The language filters applied to the output suggestions. If set, it should contain the language of the query. If not set, suggestions are returned without considering language restrictions. This is the BCP-47 language code, such as &quot;en-US&quot; or &quot;sr-Latn&quot;. For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). The maximum number of language codes is 3. (repeated)
  maxSuggestions: integer, Completion max suggestions. If left unset or set to 0, then will fallback to the configured value CompletionConfig.max_suggestions. The maximum allowed max suggestions is 20. If it is set higher, it will be capped by 20.
  query: string, Required. The query used to generate suggestions. The maximum number of allowed characters is 255.
  visitorId: string, Recommended field. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response of the autocomplete query.
  &quot;attributeResults&quot;: { # A map of matched attribute suggestions. This field is only available for `cloud-retail` dataset. Current supported keys: * `brands` * `categories`
    &quot;a_key&quot;: { # Resource that represents attribute results.
      &quot;suggestions&quot;: [ # The list of suggestions for the attribute.
        &quot;A String&quot;,
      ],
    },
  },
  &quot;attributionToken&quot;: &quot;A String&quot;, # A unique complete token. This should be included in the UserEvent.completion_detail for search events resulting from this completion, which enables accurate attribution of complete model performance.
  &quot;completionResults&quot;: [ # Results of the matching suggestions. The result list is ordered and the first result is top suggestion.
    { # Resource that represents completion results.
      &quot;attributes&quot;: { # Custom attributes for the suggestion term. * For `user-data`, the attributes are additional custom attributes ingested through BigQuery. * For `cloud-retail`, the attributes are product attributes generated by Cloud Retail. It requires UserEvent.product_details is imported properly.
        &quot;a_key&quot;: { # A custom attribute that is not explicitly modeled in Product.
          &quot;indexable&quot;: True or False, # This field is normally ignored unless AttributesConfig.attribute_config_level of the Catalog is set to the deprecated &#x27;PRODUCT_LEVEL_ATTRIBUTE_CONFIG&#x27; mode. For information about product-level attribute configuration, see [Configuration modes](https://cloud.google.com/retail/docs/attribute-config#config-modes). If true, custom attribute values are indexed, so that they can be filtered, faceted or boosted in SearchService.Search. This field is ignored in a UserEvent. See SearchRequest.filter, SearchRequest.facet_specs and SearchRequest.boost_spec for more details.
          &quot;numbers&quot;: [ # The numerical values of this custom attribute. For example, `[2.3, 15.4]` when the key is &quot;lengths_cm&quot;. Exactly one of text or numbers should be set. Otherwise, an INVALID_ARGUMENT error is returned.
            3.14,
          ],
          &quot;searchable&quot;: True or False, # This field is normally ignored unless AttributesConfig.attribute_config_level of the Catalog is set to the deprecated &#x27;PRODUCT_LEVEL_ATTRIBUTE_CONFIG&#x27; mode. For information about product-level attribute configuration, see [Configuration modes](https://cloud.google.com/retail/docs/attribute-config#config-modes). If true, custom attribute values are searchable by text queries in SearchService.Search. This field is ignored in a UserEvent. Only set if type text is set. Otherwise, a INVALID_ARGUMENT error is returned.
          &quot;text&quot;: [ # The textual values of this custom attribute. For example, `[&quot;yellow&quot;, &quot;green&quot;]` when the key is &quot;color&quot;. Empty string is not allowed. Otherwise, an INVALID_ARGUMENT error is returned. Exactly one of text or numbers should be set. Otherwise, an INVALID_ARGUMENT error is returned.
            &quot;A String&quot;,
          ],
        },
      },
      &quot;facets&quot;: [ # Facet information for the suggestion term. Gives the number of items resulting from a search with this suggestion term for each facet. This is an experimental feature for limited customers. If you want to receive this facet information, reach out to the Retail support team.
        { # A facet result.
          &quot;dynamicFacet&quot;: True or False, # Whether the facet is dynamically generated.
          &quot;key&quot;: &quot;A String&quot;, # The key for this facet. E.g., &quot;colorFamilies&quot; or &quot;price&quot; or &quot;attributes.attr1&quot;.
          &quot;values&quot;: [ # The facet values for this field.
            { # A facet value which contains value names and their count.
              &quot;count&quot;: &quot;A String&quot;, # Number of items that have this facet value.
              &quot;interval&quot;: { # A floating point interval. # Interval value for a facet, such as [10, 20) for facet &quot;price&quot;.
                &quot;exclusiveMaximum&quot;: 3.14, # Exclusive upper bound.
                &quot;exclusiveMinimum&quot;: 3.14, # Exclusive lower bound.
                &quot;maximum&quot;: 3.14, # Inclusive upper bound.
                &quot;minimum&quot;: 3.14, # Inclusive lower bound.
              },
              &quot;maxValue&quot;: 3.14, # The maximum value in the FacetValue.interval. Only supported on numerical facets and returned if SearchRequest.FacetSpec.FacetKey.return_min_max is true.
              &quot;minValue&quot;: 3.14, # The minimum value in the FacetValue.interval. Only supported on numerical facets and returned if SearchRequest.FacetSpec.FacetKey.return_min_max is true.
              &quot;value&quot;: &quot;A String&quot;, # Text value of a facet, such as &quot;Black&quot; for facet &quot;colorFamilies&quot;.
            },
          ],
        },
      ],
      &quot;suggestion&quot;: &quot;A String&quot;, # The suggestion for the query.
      &quot;totalProductCount&quot;: 42, # Total number of products associated with a search with this suggestion. This is an experimental feature for limited customers. If you want to receive this product count information, reach out to the Retail support team.
    },
  ],
  &quot;recentSearchResults&quot;: [ # Deprecated. Matched recent searches of this user. The maximum number of recent searches is 10. This field is a restricted feature. If you want to enable it, contact Retail Search support. This feature is only available when CompleteQueryRequest.visitor_id field is set and UserEvent is imported. The recent searches satisfy the follow rules: * They are ordered from latest to oldest. * They are matched with CompleteQueryRequest.query case insensitively. * They are transformed to lower case. * They are UTF-8 safe. Recent searches are deduplicated. More recent searches will be reserved when duplication happens.
    { # Deprecated: Recent search of this user.
      &quot;recentSearch&quot;: &quot;A String&quot;, # The recent search query.
    },
  ],
}</pre>
</div>

<div class="method">
    <code class="details" id="exportAnalyticsMetrics">exportAnalyticsMetrics(catalog, body=None, x__xgafv=None)</code>
  <pre>Exports analytics metrics. `Operation.response` is of type `ExportAnalyticsMetricsResponse`. `Operation.metadata` is of type `ExportMetadata`.

Args:
  catalog: string, Required. Full resource name of the parent catalog. Expected format: `projects/*/locations/*/catalogs/*` (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for the `ExportAnalyticsMetrics` method.
  &quot;filter&quot;: &quot;A String&quot;, # A filtering expression to specify restrictions on returned metrics. The expression is a sequence of terms. Each term applies a restriction to the returned metrics. Use this expression to restrict results to a specific time range. Currently we expect only one types of fields: * `timestamp`: This can be specified twice, once with a less than operator and once with a greater than operator. The `timestamp` restriction should result in one, contiguous, valid, `timestamp` range. Some examples of valid filters expressions: * Example 1: `timestamp &gt; &quot;2012-04-23T18:25:43.511Z&quot; timestamp &lt; &quot;2012-04-23T18:30:43.511Z&quot;` * Example 2: `timestamp &gt; &quot;2012-04-23T18:25:43.511Z&quot;`
  &quot;outputConfig&quot;: { # The output configuration setting. # Required. The output location of the data.
    &quot;bigqueryDestination&quot;: { # The BigQuery output destination configuration. # The BigQuery location where the output is to be written to.
      &quot;datasetId&quot;: &quot;A String&quot;, # Required. The ID of a BigQuery Dataset.
      &quot;tableIdPrefix&quot;: &quot;A String&quot;, # Required. The prefix of exported BigQuery tables.
      &quot;tableType&quot;: &quot;A String&quot;, # Required. Describes the table type. The following values are supported: * `table`: A BigQuery native table. * `view`: A virtual table defined by a SQL query.
    },
    &quot;gcsDestination&quot;: { # The Google Cloud Storage output destination configuration. # The Google Cloud Storage location where the output is to be written to.
      &quot;outputUriPrefix&quot;: &quot;A String&quot;, # Required. The output uri prefix for saving output data to json files. Some mapping examples are as follows: output_uri_prefix sample output(assuming the object is foo.json) ======================== ============================================= gs://bucket/ gs://bucket/foo.json gs://bucket/folder/ gs://bucket/folder/foo.json gs://bucket/folder/item_ gs://bucket/folder/item_foo.json
    },
  },
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="getAttributesConfig">getAttributesConfig(name, x__xgafv=None)</code>
  <pre>Gets an AttributesConfig.

Args:
  name: string, Required. Full AttributesConfig resource name. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/attributesConfig` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Catalog level attribute config.
  &quot;attributeConfigLevel&quot;: &quot;A String&quot;, # Output only. The AttributeConfigLevel used for this catalog.
  &quot;catalogAttributes&quot;: { # Enable attribute(s) config at catalog level. For example, indexable, dynamic_facetable, or searchable for each attribute. The key is catalog attribute&#x27;s name. For example: `color`, `brands`, `attributes.custom_attribute`, such as `attributes.xyz`. The maximum number of catalog attributes allowed in a request is 1000.
    &quot;a_key&quot;: { # Catalog level attribute config for an attribute. For example, if customers want to enable/disable facet for a specific attribute.
      &quot;dynamicFacetableOption&quot;: &quot;A String&quot;, # If DYNAMIC_FACETABLE_ENABLED, attribute values are available for dynamic facet. Could only be DYNAMIC_FACETABLE_DISABLED if CatalogAttribute.indexable_option is INDEXABLE_DISABLED. Otherwise, an INVALID_ARGUMENT error is returned. Must be specified, otherwise throws INVALID_FORMAT error.
      &quot;exactSearchableOption&quot;: &quot;A String&quot;, # If EXACT_SEARCHABLE_ENABLED, attribute values will be exact searchable. This property only applies to textual custom attributes and requires indexable set to enabled to enable exact-searchable. If unset, the server behavior defaults to EXACT_SEARCHABLE_DISABLED.
      &quot;facetConfig&quot;: { # Possible options for the facet that corresponds to the current attribute config. # Contains facet options.
        &quot;facetIntervals&quot;: [ # If you don&#x27;t set the facet SearchRequest.FacetSpec.FacetKey.intervals in the request to a numerical attribute, then we use the computed intervals with rounded bounds obtained from all its product numerical attribute values. The computed intervals might not be ideal for some attributes. Therefore, we give you the option to overwrite them with the facet_intervals field. The maximum of facet intervals per CatalogAttribute is 40. Each interval must have a lower bound or an upper bound. If both bounds are provided, then the lower bound must be smaller or equal than the upper bound.
          { # A floating point interval.
            &quot;exclusiveMaximum&quot;: 3.14, # Exclusive upper bound.
            &quot;exclusiveMinimum&quot;: 3.14, # Exclusive lower bound.
            &quot;maximum&quot;: 3.14, # Inclusive upper bound.
            &quot;minimum&quot;: 3.14, # Inclusive lower bound.
          },
        ],
        &quot;ignoredFacetValues&quot;: [ # Each instance represents a list of attribute values to ignore as facet values for a specific time range. The maximum number of instances per CatalogAttribute is 25.
          { # Facet values to ignore on facets during the specified time range for the given SearchResponse.Facet.key attribute.
            &quot;endTime&quot;: &quot;A String&quot;, # If start time is empty and end time is not empty, then ignore these facet values before end time.
            &quot;startTime&quot;: &quot;A String&quot;, # Time range for the current list of facet values to ignore. If multiple time ranges are specified for an facet value for the current attribute, consider all of them. If both are empty, ignore always. If start time and end time are set, then start time must be before end time. If start time is not empty and end time is empty, then will ignore these facet values after the start time.
            &quot;values&quot;: [ # List of facet values to ignore for the following time range. The facet values are the same as the attribute values. There is a limit of 10 values per instance of IgnoredFacetValues. Each value can have at most 128 characters.
              &quot;A String&quot;,
            ],
          },
        ],
        &quot;mergedFacet&quot;: { # The current facet key (i.e. attribute config) maps into the merged_facet_key. A facet key can have at most one child. The current facet key and the merged facet key need both to be textual custom attributes or both numerical custom attributes (same type). # Use this field only if you want to merge a facet key into another facet key.
          &quot;mergedFacetKey&quot;: &quot;A String&quot;, # The merged facet key should be a valid facet key that is different than the facet key of the current catalog attribute. We refer this is merged facet key as the child of the current catalog attribute. This merged facet key can&#x27;t be a parent of another facet key (i.e. no directed path of length 2). This merged facet key needs to be either a textual custom attribute or a numerical custom attribute.
        },
        &quot;mergedFacetValues&quot;: [ # Each instance replaces a list of facet values by a merged facet value. If a facet value is not in any list, then it will stay the same. To avoid conflicts, only paths of length 1 are accepted. In other words, if &quot;dark_blue&quot; merged into &quot;BLUE&quot;, then the latter can&#x27;t merge into &quot;blues&quot; because this would create a path of length 2. The maximum number of instances of MergedFacetValue per CatalogAttribute is 100. This feature is available only for textual custom attributes.
          { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes.
            &quot;mergedValue&quot;: &quot;A String&quot;, # All the previous values are replaced by this merged facet value. This merged_value must be non-empty and can have up to 128 characters.
            &quot;values&quot;: [ # All the facet values that are replaces by the same merged_value that follows. The maximum number of values per MergedFacetValue is 25. Each value can have up to 128 characters.
              &quot;A String&quot;,
            ],
          },
        ],
        &quot;rerankConfig&quot;: { # Options to rerank based on facet values engaged by the user for the current key. That key needs to be a custom textual key and facetable. To use this control, you also need to pass all the facet keys engaged by the user in the request using the field [SearchRequest.FacetSpec]. In particular, if you don&#x27;t pass the facet keys engaged that you want to rerank on, this control won&#x27;t be effective. Moreover, to obtain better results, the facet values that you want to rerank on should be close to English (ideally made of words, underscores, and spaces). # Set this field only if you want to rerank based on facet values engaged by the user for the current key. This option is only possible for custom facetable textual keys.
          &quot;facetValues&quot;: [ # If empty, rerank on all facet values for the current key. Otherwise, will rerank on the facet values from this list only.
            &quot;A String&quot;,
          ],
          &quot;rerankFacet&quot;: True or False, # If set to true, then we also rerank the dynamic facets based on the facet values engaged by the user for the current attribute key during serving.
        },
      },
      &quot;inUse&quot;: True or False, # Output only. Indicates whether this attribute has been used by any products. `True` if at least one Product is using this attribute in Product.attributes. Otherwise, this field is `False`. CatalogAttribute can be pre-loaded by using CatalogService.AddCatalogAttribute or CatalogService.UpdateAttributesConfig APIs. This field is `False` for pre-loaded CatalogAttributes. Only pre-loaded catalog attributes that are neither in use by products nor predefined can be deleted. Catalog attributes that are either in use by products or are predefined attributes cannot be deleted; however, their configuration properties will reset to default values upon removal request. After catalog changes, it takes about 10 minutes for this field to update.
      &quot;indexableOption&quot;: &quot;A String&quot;, # When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if INDEXABLE_ENABLED attribute values are indexed so that it can be filtered, faceted, or boosted in SearchService.Search. Must be specified when AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, otherwise throws INVALID_FORMAT error.
      &quot;key&quot;: &quot;A String&quot;, # Required. Attribute name. For example: `color`, `brands`, `attributes.custom_attribute`, such as `attributes.xyz`. To be indexable, the attribute name can contain only alpha-numeric characters and underscores. For example, an attribute named `attributes.abc_xyz` can be indexed, but an attribute named `attributes.abc-xyz` cannot be indexed. If the attribute key starts with `attributes.`, then the attribute is a custom attribute. Attributes such as `brands`, `patterns`, and `title` are built-in and called system attributes.
      &quot;recommendationsFilteringOption&quot;: &quot;A String&quot;, # When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if RECOMMENDATIONS_FILTERING_ENABLED, attribute values are filterable for recommendations. This option works for categorical features only, does not work for numerical features, inventory filtering.
      &quot;retrievableOption&quot;: &quot;A String&quot;, # If RETRIEVABLE_ENABLED, attribute values are retrievable in the search results. If unset, the server behavior defaults to RETRIEVABLE_DISABLED.
      &quot;searchableOption&quot;: &quot;A String&quot;, # When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if SEARCHABLE_ENABLED, attribute values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but attribute type is numerical, attribute values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical attributes. Must be specified, when AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, otherwise throws INVALID_FORMAT error.
      &quot;type&quot;: &quot;A String&quot;, # Output only. The type of this attribute. This is derived from the attribute in Product.attributes.
    },
  },
  &quot;name&quot;: &quot;A String&quot;, # Required. Immutable. The fully qualified resource name of the attribute config. Format: `projects/*/locations/*/catalogs/*/attributesConfig`
}</pre>
</div>

<div class="method">
    <code class="details" id="getCompletionConfig">getCompletionConfig(name, x__xgafv=None)</code>
  <pre>Gets a CompletionConfig.

Args:
  name: string, Required. Full CompletionConfig resource name. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/completionConfig` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Catalog level autocomplete config for customers to customize autocomplete feature&#x27;s settings.
  &quot;allowlistInputConfig&quot;: { # The input config source for completion data. # Output only. The source data for the latest import of the autocomplete allowlist phrases.
    &quot;bigQuerySource&quot;: { # BigQuery source import data from. # Required. BigQuery input source. Add the IAM permission &quot;BigQuery Data Viewer&quot; for cloud-retail-customer-data-access@system.gserviceaccount.com before using this feature otherwise an error is thrown.
      &quot;dataSchema&quot;: &quot;A String&quot;, # The schema to use when parsing the data from the source. Supported values for product imports: * `product` (default): One JSON Product per line. Each product must have a valid Product.id. * `product_merchant_center`: See [Importing catalog data from Merchant Center](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mc). Supported values for user events imports: * `user_event` (default): One JSON UserEvent per line. * `user_event_ga360`: The schema is available here: https://support.google.com/analytics/answer/3437719. * `user_event_ga4`: The schema is available here: https://support.google.com/analytics/answer/7029846. Supported values for autocomplete imports: * `suggestions` (default): One JSON completion suggestion per line. * `denylist`: One JSON deny suggestion per line. * `allowlist`: One JSON allow suggestion per line.
      &quot;datasetId&quot;: &quot;A String&quot;, # Required. The BigQuery data set to copy the data from with a length limit of 1,024 characters.
      &quot;gcsStagingDir&quot;: &quot;A String&quot;, # Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the BigQuery export to a specific Cloud Storage directory.
      &quot;partitionDate&quot;: { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # BigQuery time partitioned table&#x27;s _PARTITIONDATE in YYYY-MM-DD format.
        &quot;day&quot;: 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn&#x27;t significant.
        &quot;month&quot;: 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
        &quot;year&quot;: 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
      },
      &quot;projectId&quot;: &quot;A String&quot;, # The project ID (can be project # or ID) that the BigQuery source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.
      &quot;tableId&quot;: &quot;A String&quot;, # Required. The BigQuery table to copy the data from with a length limit of 1,024 characters.
    },
  },
  &quot;autoLearning&quot;: True or False, # If set to true, the auto learning function is enabled. Auto learning uses user data to generate suggestions using ML techniques. Default value is false. Only after enabling auto learning can users use `cloud-retail` data in CompleteQueryRequest.
  &quot;denylistInputConfig&quot;: { # The input config source for completion data. # Output only. The source data for the latest import of the autocomplete denylist phrases.
    &quot;bigQuerySource&quot;: { # BigQuery source import data from. # Required. BigQuery input source. Add the IAM permission &quot;BigQuery Data Viewer&quot; for cloud-retail-customer-data-access@system.gserviceaccount.com before using this feature otherwise an error is thrown.
      &quot;dataSchema&quot;: &quot;A String&quot;, # The schema to use when parsing the data from the source. Supported values for product imports: * `product` (default): One JSON Product per line. Each product must have a valid Product.id. * `product_merchant_center`: See [Importing catalog data from Merchant Center](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mc). Supported values for user events imports: * `user_event` (default): One JSON UserEvent per line. * `user_event_ga360`: The schema is available here: https://support.google.com/analytics/answer/3437719. * `user_event_ga4`: The schema is available here: https://support.google.com/analytics/answer/7029846. Supported values for autocomplete imports: * `suggestions` (default): One JSON completion suggestion per line. * `denylist`: One JSON deny suggestion per line. * `allowlist`: One JSON allow suggestion per line.
      &quot;datasetId&quot;: &quot;A String&quot;, # Required. The BigQuery data set to copy the data from with a length limit of 1,024 characters.
      &quot;gcsStagingDir&quot;: &quot;A String&quot;, # Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the BigQuery export to a specific Cloud Storage directory.
      &quot;partitionDate&quot;: { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # BigQuery time partitioned table&#x27;s _PARTITIONDATE in YYYY-MM-DD format.
        &quot;day&quot;: 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn&#x27;t significant.
        &quot;month&quot;: 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
        &quot;year&quot;: 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
      },
      &quot;projectId&quot;: &quot;A String&quot;, # The project ID (can be project # or ID) that the BigQuery source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.
      &quot;tableId&quot;: &quot;A String&quot;, # Required. The BigQuery table to copy the data from with a length limit of 1,024 characters.
    },
  },
  &quot;lastAllowlistImportOperation&quot;: &quot;A String&quot;, # Output only. Name of the LRO corresponding to the latest allowlist import. Can use GetOperation API to retrieve the latest state of the Long Running Operation.
  &quot;lastDenylistImportOperation&quot;: &quot;A String&quot;, # Output only. Name of the LRO corresponding to the latest denylist import. Can use GetOperation API to retrieve the latest state of the Long Running Operation.
  &quot;lastSuggestionsImportOperation&quot;: &quot;A String&quot;, # Output only. Name of the LRO corresponding to the latest suggestion terms list import. Can use GetOperation API method to retrieve the latest state of the Long Running Operation.
  &quot;matchingOrder&quot;: &quot;A String&quot;, # Specifies the matching order for autocomplete suggestions, e.g., a query consisting of &#x27;sh&#x27; with &#x27;out-of-order&#x27; specified would suggest &quot;women&#x27;s shoes&quot;, whereas a query of &#x27;red s&#x27; with &#x27;exact-prefix&#x27; specified would suggest &quot;red shoes&quot;. Currently supported values: * &#x27;out-of-order&#x27; * &#x27;exact-prefix&#x27; Default value: &#x27;exact-prefix&#x27;.
  &quot;maxSuggestions&quot;: 42, # The maximum number of autocomplete suggestions returned per term. Default value is 20. If left unset or set to 0, then will fallback to default value. Value range is 1 to 20.
  &quot;minPrefixLength&quot;: 42, # The minimum number of characters needed to be typed in order to get suggestions. Default value is 2. If left unset or set to 0, then will fallback to default value. Value range is 1 to 20.
  &quot;name&quot;: &quot;A String&quot;, # Required. Immutable. Fully qualified name `projects/*/locations/*/catalogs/*/completionConfig`
  &quot;suggestionsInputConfig&quot;: { # The input config source for completion data. # Output only. The source data for the latest import of the autocomplete suggestion phrases.
    &quot;bigQuerySource&quot;: { # BigQuery source import data from. # Required. BigQuery input source. Add the IAM permission &quot;BigQuery Data Viewer&quot; for cloud-retail-customer-data-access@system.gserviceaccount.com before using this feature otherwise an error is thrown.
      &quot;dataSchema&quot;: &quot;A String&quot;, # The schema to use when parsing the data from the source. Supported values for product imports: * `product` (default): One JSON Product per line. Each product must have a valid Product.id. * `product_merchant_center`: See [Importing catalog data from Merchant Center](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mc). Supported values for user events imports: * `user_event` (default): One JSON UserEvent per line. * `user_event_ga360`: The schema is available here: https://support.google.com/analytics/answer/3437719. * `user_event_ga4`: The schema is available here: https://support.google.com/analytics/answer/7029846. Supported values for autocomplete imports: * `suggestions` (default): One JSON completion suggestion per line. * `denylist`: One JSON deny suggestion per line. * `allowlist`: One JSON allow suggestion per line.
      &quot;datasetId&quot;: &quot;A String&quot;, # Required. The BigQuery data set to copy the data from with a length limit of 1,024 characters.
      &quot;gcsStagingDir&quot;: &quot;A String&quot;, # Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the BigQuery export to a specific Cloud Storage directory.
      &quot;partitionDate&quot;: { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # BigQuery time partitioned table&#x27;s _PARTITIONDATE in YYYY-MM-DD format.
        &quot;day&quot;: 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn&#x27;t significant.
        &quot;month&quot;: 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
        &quot;year&quot;: 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
      },
      &quot;projectId&quot;: &quot;A String&quot;, # The project ID (can be project # or ID) that the BigQuery source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.
      &quot;tableId&quot;: &quot;A String&quot;, # Required. The BigQuery table to copy the data from with a length limit of 1,024 characters.
    },
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="getConversationalSearchCustomizationConfig">getConversationalSearchCustomizationConfig(name, x__xgafv=None)</code>
  <pre>Returns the conversational search customization config for a given catalog.

Args:
  name: string, Required. Resource name of the parent catalog. Format: projects/{project}/locations/{location}/catalogs/{catalog} (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The public proto to represent the conversational search customization config. It will be converted to the internal proto in the backend.
  &quot;catalog&quot;: &quot;A String&quot;, # Required. Resource name of the catalog. Format: projects/{project}/locations/{location}/catalogs/{catalog}
  &quot;intentClassificationConfig&quot;: { # The public proto to represent the intent classification config. It will be converted to the internal proto in the backend. # Optional. The configs for intent classification.
    &quot;blocklistKeywords&quot;: [ # Optional. A list of keywords that will be used to classify the query to the &quot;BLOCKLISTED&quot; intent type. The keywords are case insensitive.
      &quot;A String&quot;,
    ],
    &quot;disabledIntentTypes&quot;: [ # Optional. A list of intent types that will be disabled for this customer. The intent types must match one of the predefined intent types defined at https://cloud.google.com/retail/docs/reference/rpc/google.cloud.retail.v2alpha#querytype
      &quot;A String&quot;,
    ],
    &quot;example&quot;: [ # Optional. A list of examples for intent classification.
      { # An example for intent classification.
        &quot;classifiedPositive&quot;: True or False, # Required. Whether the example is classified positively.
        &quot;intentType&quot;: &quot;A String&quot;, # Optional. The intent_type must match one of the predefined intent types defined at https://cloud.google.com/retail/docs/reference/rpc/google.cloud.retail.v2alpha#querytype
        &quot;query&quot;: &quot;A String&quot;, # Required. Example query.
        &quot;reason&quot;: &quot;A String&quot;, # Optional. The reason for the intent classification. This is used to explain the intent classification decision.
      },
    ],
    &quot;inlineSource&quot;: { # Inline source for intent classifications. # Optional. Inline source for intent classifications.
      &quot;inlineForceIntents&quot;: [ # Optional. A list of inline force intent classifications.
        { # An inline force intent classification configuration.
          &quot;intentType&quot;: &quot;A String&quot;, # Optional. The intent_type must match one of the predefined intent types defined at https://cloud.google.com/retail/docs/reference/rpc/google.cloud.retail.v2alpha#querytype
          &quot;operation&quot;: &quot;A String&quot;, # Optional. The operation to perform for the query.
          &quot;query&quot;: &quot;A String&quot;, # Optional. A example query.
        },
      ],
    },
    &quot;modelPreamble&quot;: &quot;A String&quot;, # Optional. Customers can use the preamble to specify any requirements for blocklisting intent classification. This preamble will be added to the blocklisting intent classification model prompt.
  },
  &quot;retailerDisplayName&quot;: &quot;A String&quot;, # Optional. The retailer&#x27;s display name that could be used in our LLM answers. Example - &quot;Google&quot;
}</pre>
</div>

<div class="method">
    <code class="details" id="getDefaultBranch">getDefaultBranch(catalog, x__xgafv=None)</code>
  <pre>Get which branch is currently default branch set by CatalogService.SetDefaultBranch method under a specified parent catalog.

Args:
  catalog: string, The parent catalog resource name, such as `projects/*/locations/global/catalogs/default_catalog`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message of CatalogService.GetDefaultBranch.
  &quot;branch&quot;: &quot;A String&quot;, # Full resource name of the branch id currently set as default branch.
  &quot;note&quot;: &quot;A String&quot;, # This corresponds to SetDefaultBranchRequest.note field, when this branch was set as default.
  &quot;setTime&quot;: &quot;A String&quot;, # The time when this branch is set to default.
}</pre>
</div>

<div class="method">
    <code class="details" id="getGenerativeQuestionFeature">getGenerativeQuestionFeature(catalog, x__xgafv=None)</code>
  <pre>Manages overal generative question feature state -- enables toggling feature on and off.

Args:
  catalog: string, Required. Resource name of the parent catalog. Format: projects/{project}/locations/{location}/catalogs/{catalog} (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Configuration for overall generative question feature state.
  &quot;catalog&quot;: &quot;A String&quot;, # Required. Resource name of the affected catalog. Format: projects/{project}/locations/{location}/catalogs/{catalog}
  &quot;featureEnabled&quot;: True or False, # Optional. Determines whether questions will be used at serving time. Note: This feature cannot be enabled until initial data requirements are satisfied.
  &quot;minimumProducts&quot;: 42, # Optional. Minimum number of products in the response to trigger follow-up questions. Value must be 0 or positive.
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
  <pre>Lists all the Catalogs associated with the project.

Args:
  parent: string, Required. The account resource name with an associated location. If the caller does not have permission to list Catalogs under this location, regardless of whether or not this location exists, a PERMISSION_DENIED error is returned. (required)
  pageSize: integer, Maximum number of Catalogs to return. If unspecified, defaults to 50. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT is returned.
  pageToken: string, A page token ListCatalogsResponse.next_page_token, received from a previous CatalogService.ListCatalogs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to CatalogService.ListCatalogs must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for CatalogService.ListCatalogs method.
  &quot;catalogs&quot;: [ # All the customer&#x27;s Catalogs.
    { # The catalog configuration.
      &quot;displayName&quot;: &quot;A String&quot;, # Required. Immutable. The catalog display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
      &quot;merchantCenterLinkingConfig&quot;: { # Configures Merchant Center linking. Links contained in the config will be used to sync data from a Merchant Center account to a Cloud Retail branch. # The Merchant Center linking configuration. After a link is added, the data stream from Merchant Center to Cloud Retail will be enabled automatically. The requester must have access to the Merchant Center account in order to make changes to this field.
        &quot;links&quot;: [ # Links between Merchant Center accounts and branches.
          { # Represents a link between a Merchant Center account and a branch. After a link is established, products from the linked Merchant Center account are streamed to the linked branch.
            &quot;branchId&quot;: &quot;A String&quot;, # The branch ID (e.g. 0/1/2) within this catalog that products from merchant_center_account_id are streamed to. When updating this field, an empty value will use the currently configured default branch. However, changing the default branch later on won&#x27;t change the linked branch here. A single branch ID can only have one linked Merchant Center account ID.
            &quot;destinations&quot;: [ # String representing the destination to import for, all if left empty. List of possible values is given in [Included destination](https://support.google.com/merchants/answer/7501026). List of allowed string values: &quot;Shopping_ads&quot;, &quot;Buy_on_google_listings&quot;, &quot;Display_ads&quot;, &quot;Local_inventory _ads&quot;, &quot;Free_listings&quot;, &quot;Free_local_listings&quot; NOTE: The string values are case sensitive.
              &quot;A String&quot;,
            ],
            &quot;feeds&quot;: [ # Criteria for the Merchant Center feeds to be ingested via the link. All offers will be ingested if the list is empty. Otherwise the offers will be ingested from selected feeds.
              { # Merchant Center Feed filter criterion.
                &quot;dataSourceId&quot;: &quot;A String&quot;, # AFM data source ID.
                &quot;primaryFeedId&quot;: &quot;A String&quot;, # Merchant Center primary feed ID. Deprecated: use data_source_id instead.
                &quot;primaryFeedName&quot;: &quot;A String&quot;, # Merchant Center primary feed name. The name is used for the display purposes only.
              },
            ],
            &quot;languageCode&quot;: &quot;A String&quot;, # Language of the title/description and other string attributes. Use language tags defined by [BCP 47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). ISO 639-1. This specifies the language of offers in Merchant Center that will be accepted. If empty no language filtering will be performed. Example value: `en`.
            &quot;merchantCenterAccountId&quot;: &quot;A String&quot;, # Required. The linked [Merchant Center account ID](https://developers.google.com/shopping-content/guides/accountstatuses). The account must be a standalone account or a sub-account of a MCA.
            &quot;regionCode&quot;: &quot;A String&quot;, # Region code of offers to accept. 2-letter Uppercase ISO 3166-1 alpha-2 code. List of values can be found [here](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) under the `region` tag. If left blank no region filtering will be performed. Example value: `US`.
          },
        ],
      },
      &quot;name&quot;: &quot;A String&quot;, # Required. Immutable. The fully qualified resource name of the catalog.
      &quot;productLevelConfig&quot;: { # Configures what level the product should be uploaded with regards to how users will be send events and how predictions will be made. # Required. The product level configuration.
        &quot;ingestionProductType&quot;: &quot;A String&quot;, # The type of Products allowed to be ingested into the catalog. Acceptable values are: * `primary` (default): You can ingest Products of all types. When ingesting a Product, its type will default to Product.Type.PRIMARY if unset. * `variant` (incompatible with Retail Search): You can only ingest Product.Type.VARIANT Products. This means Product.primary_product_id cannot be empty. If this field is set to an invalid value other than these, an INVALID_ARGUMENT error is returned. If this field is `variant` and merchant_center_product_id_field is `itemGroupId`, an INVALID_ARGUMENT error is returned. See [Product levels](https://cloud.google.com/retail/docs/catalog#product-levels) for more details.
        &quot;merchantCenterProductIdField&quot;: &quot;A String&quot;, # Which field of [Merchant Center Product](/bigquery-transfer/docs/merchant-center-products-schema) should be imported as Product.id. Acceptable values are: * `offerId` (default): Import `offerId` as the product ID. * `itemGroupId`: Import `itemGroupId` as the product ID. Notice that Retail API will choose one item from the ones with the same `itemGroupId`, and use it to represent the item group. If this field is set to an invalid value other than these, an INVALID_ARGUMENT error is returned. If this field is `itemGroupId` and ingestion_product_type is `variant`, an INVALID_ARGUMENT error is returned. See [Product levels](https://cloud.google.com/retail/docs/catalog#product-levels) for more details.
      },
    },
  ],
  &quot;nextPageToken&quot;: &quot;A String&quot;, # A token that can be sent as ListCatalogsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
}</pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_next()</code>
  <pre>Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

<div class="method">
    <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
  <pre>Updates the Catalogs.

Args:
  name: string, Required. Immutable. The fully qualified resource name of the catalog. (required)
  body: object, The request body.
    The object takes the form of:

{ # The catalog configuration.
  &quot;displayName&quot;: &quot;A String&quot;, # Required. Immutable. The catalog display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
  &quot;merchantCenterLinkingConfig&quot;: { # Configures Merchant Center linking. Links contained in the config will be used to sync data from a Merchant Center account to a Cloud Retail branch. # The Merchant Center linking configuration. After a link is added, the data stream from Merchant Center to Cloud Retail will be enabled automatically. The requester must have access to the Merchant Center account in order to make changes to this field.
    &quot;links&quot;: [ # Links between Merchant Center accounts and branches.
      { # Represents a link between a Merchant Center account and a branch. After a link is established, products from the linked Merchant Center account are streamed to the linked branch.
        &quot;branchId&quot;: &quot;A String&quot;, # The branch ID (e.g. 0/1/2) within this catalog that products from merchant_center_account_id are streamed to. When updating this field, an empty value will use the currently configured default branch. However, changing the default branch later on won&#x27;t change the linked branch here. A single branch ID can only have one linked Merchant Center account ID.
        &quot;destinations&quot;: [ # String representing the destination to import for, all if left empty. List of possible values is given in [Included destination](https://support.google.com/merchants/answer/7501026). List of allowed string values: &quot;Shopping_ads&quot;, &quot;Buy_on_google_listings&quot;, &quot;Display_ads&quot;, &quot;Local_inventory _ads&quot;, &quot;Free_listings&quot;, &quot;Free_local_listings&quot; NOTE: The string values are case sensitive.
          &quot;A String&quot;,
        ],
        &quot;feeds&quot;: [ # Criteria for the Merchant Center feeds to be ingested via the link. All offers will be ingested if the list is empty. Otherwise the offers will be ingested from selected feeds.
          { # Merchant Center Feed filter criterion.
            &quot;dataSourceId&quot;: &quot;A String&quot;, # AFM data source ID.
            &quot;primaryFeedId&quot;: &quot;A String&quot;, # Merchant Center primary feed ID. Deprecated: use data_source_id instead.
            &quot;primaryFeedName&quot;: &quot;A String&quot;, # Merchant Center primary feed name. The name is used for the display purposes only.
          },
        ],
        &quot;languageCode&quot;: &quot;A String&quot;, # Language of the title/description and other string attributes. Use language tags defined by [BCP 47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). ISO 639-1. This specifies the language of offers in Merchant Center that will be accepted. If empty no language filtering will be performed. Example value: `en`.
        &quot;merchantCenterAccountId&quot;: &quot;A String&quot;, # Required. The linked [Merchant Center account ID](https://developers.google.com/shopping-content/guides/accountstatuses). The account must be a standalone account or a sub-account of a MCA.
        &quot;regionCode&quot;: &quot;A String&quot;, # Region code of offers to accept. 2-letter Uppercase ISO 3166-1 alpha-2 code. List of values can be found [here](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) under the `region` tag. If left blank no region filtering will be performed. Example value: `US`.
      },
    ],
  },
  &quot;name&quot;: &quot;A String&quot;, # Required. Immutable. The fully qualified resource name of the catalog.
  &quot;productLevelConfig&quot;: { # Configures what level the product should be uploaded with regards to how users will be send events and how predictions will be made. # Required. The product level configuration.
    &quot;ingestionProductType&quot;: &quot;A String&quot;, # The type of Products allowed to be ingested into the catalog. Acceptable values are: * `primary` (default): You can ingest Products of all types. When ingesting a Product, its type will default to Product.Type.PRIMARY if unset. * `variant` (incompatible with Retail Search): You can only ingest Product.Type.VARIANT Products. This means Product.primary_product_id cannot be empty. If this field is set to an invalid value other than these, an INVALID_ARGUMENT error is returned. If this field is `variant` and merchant_center_product_id_field is `itemGroupId`, an INVALID_ARGUMENT error is returned. See [Product levels](https://cloud.google.com/retail/docs/catalog#product-levels) for more details.
    &quot;merchantCenterProductIdField&quot;: &quot;A String&quot;, # Which field of [Merchant Center Product](/bigquery-transfer/docs/merchant-center-products-schema) should be imported as Product.id. Acceptable values are: * `offerId` (default): Import `offerId` as the product ID. * `itemGroupId`: Import `itemGroupId` as the product ID. Notice that Retail API will choose one item from the ones with the same `itemGroupId`, and use it to represent the item group. If this field is set to an invalid value other than these, an INVALID_ARGUMENT error is returned. If this field is `itemGroupId` and ingestion_product_type is `variant`, an INVALID_ARGUMENT error is returned. See [Product levels](https://cloud.google.com/retail/docs/catalog#product-levels) for more details.
  },
}

  updateMask: string, Indicates which fields in the provided Catalog to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The catalog configuration.
  &quot;displayName&quot;: &quot;A String&quot;, # Required. Immutable. The catalog display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
  &quot;merchantCenterLinkingConfig&quot;: { # Configures Merchant Center linking. Links contained in the config will be used to sync data from a Merchant Center account to a Cloud Retail branch. # The Merchant Center linking configuration. After a link is added, the data stream from Merchant Center to Cloud Retail will be enabled automatically. The requester must have access to the Merchant Center account in order to make changes to this field.
    &quot;links&quot;: [ # Links between Merchant Center accounts and branches.
      { # Represents a link between a Merchant Center account and a branch. After a link is established, products from the linked Merchant Center account are streamed to the linked branch.
        &quot;branchId&quot;: &quot;A String&quot;, # The branch ID (e.g. 0/1/2) within this catalog that products from merchant_center_account_id are streamed to. When updating this field, an empty value will use the currently configured default branch. However, changing the default branch later on won&#x27;t change the linked branch here. A single branch ID can only have one linked Merchant Center account ID.
        &quot;destinations&quot;: [ # String representing the destination to import for, all if left empty. List of possible values is given in [Included destination](https://support.google.com/merchants/answer/7501026). List of allowed string values: &quot;Shopping_ads&quot;, &quot;Buy_on_google_listings&quot;, &quot;Display_ads&quot;, &quot;Local_inventory _ads&quot;, &quot;Free_listings&quot;, &quot;Free_local_listings&quot; NOTE: The string values are case sensitive.
          &quot;A String&quot;,
        ],
        &quot;feeds&quot;: [ # Criteria for the Merchant Center feeds to be ingested via the link. All offers will be ingested if the list is empty. Otherwise the offers will be ingested from selected feeds.
          { # Merchant Center Feed filter criterion.
            &quot;dataSourceId&quot;: &quot;A String&quot;, # AFM data source ID.
            &quot;primaryFeedId&quot;: &quot;A String&quot;, # Merchant Center primary feed ID. Deprecated: use data_source_id instead.
            &quot;primaryFeedName&quot;: &quot;A String&quot;, # Merchant Center primary feed name. The name is used for the display purposes only.
          },
        ],
        &quot;languageCode&quot;: &quot;A String&quot;, # Language of the title/description and other string attributes. Use language tags defined by [BCP 47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). ISO 639-1. This specifies the language of offers in Merchant Center that will be accepted. If empty no language filtering will be performed. Example value: `en`.
        &quot;merchantCenterAccountId&quot;: &quot;A String&quot;, # Required. The linked [Merchant Center account ID](https://developers.google.com/shopping-content/guides/accountstatuses). The account must be a standalone account or a sub-account of a MCA.
        &quot;regionCode&quot;: &quot;A String&quot;, # Region code of offers to accept. 2-letter Uppercase ISO 3166-1 alpha-2 code. List of values can be found [here](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) under the `region` tag. If left blank no region filtering will be performed. Example value: `US`.
      },
    ],
  },
  &quot;name&quot;: &quot;A String&quot;, # Required. Immutable. The fully qualified resource name of the catalog.
  &quot;productLevelConfig&quot;: { # Configures what level the product should be uploaded with regards to how users will be send events and how predictions will be made. # Required. The product level configuration.
    &quot;ingestionProductType&quot;: &quot;A String&quot;, # The type of Products allowed to be ingested into the catalog. Acceptable values are: * `primary` (default): You can ingest Products of all types. When ingesting a Product, its type will default to Product.Type.PRIMARY if unset. * `variant` (incompatible with Retail Search): You can only ingest Product.Type.VARIANT Products. This means Product.primary_product_id cannot be empty. If this field is set to an invalid value other than these, an INVALID_ARGUMENT error is returned. If this field is `variant` and merchant_center_product_id_field is `itemGroupId`, an INVALID_ARGUMENT error is returned. See [Product levels](https://cloud.google.com/retail/docs/catalog#product-levels) for more details.
    &quot;merchantCenterProductIdField&quot;: &quot;A String&quot;, # Which field of [Merchant Center Product](/bigquery-transfer/docs/merchant-center-products-schema) should be imported as Product.id. Acceptable values are: * `offerId` (default): Import `offerId` as the product ID. * `itemGroupId`: Import `itemGroupId` as the product ID. Notice that Retail API will choose one item from the ones with the same `itemGroupId`, and use it to represent the item group. If this field is set to an invalid value other than these, an INVALID_ARGUMENT error is returned. If this field is `itemGroupId` and ingestion_product_type is `variant`, an INVALID_ARGUMENT error is returned. See [Product levels](https://cloud.google.com/retail/docs/catalog#product-levels) for more details.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="setDefaultBranch">setDefaultBranch(catalog, body=None, x__xgafv=None)</code>
  <pre>Set a specified branch id as default branch. API methods such as SearchService.Search, ProductService.GetProduct, ProductService.ListProducts will treat requests using &quot;default_branch&quot; to the actual branch id set as default. For example, if `projects/*/locations/*/catalogs/*/branches/1` is set as default, setting SearchRequest.branch to `projects/*/locations/*/catalogs/*/branches/default_branch` is equivalent to setting SearchRequest.branch to `projects/*/locations/*/catalogs/*/branches/1`. Using multiple branches can be useful when developers would like to have a staging branch to test and verify for future usage. When it becomes ready, developers switch on the staging branch using this API while keeping using `projects/*/locations/*/catalogs/*/branches/default_branch` as SearchRequest.branch to route the traffic to this staging branch. CAUTION: If you have live predict/search traffic, switching the default branch could potentially cause outages if the ID space of the new branch is very different from the old one. More specifically: * PredictionService will only return product IDs from branch {newBranch}. * SearchService will only return product IDs from branch {newBranch} (if branch is not explicitly set). * UserEventService will only join events with products from branch {newBranch}.

Args:
  catalog: string, Full resource name of the catalog, such as `projects/*/locations/global/catalogs/default_catalog`. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message to set a specified branch as new default_branch.
  &quot;branchId&quot;: &quot;A String&quot;, # The final component of the resource name of a branch. This field must be one of &quot;0&quot;, &quot;1&quot; or &quot;2&quot;. Otherwise, an INVALID_ARGUMENT error is returned. If there are no sufficient active products in the targeted branch and force is not set, a FAILED_PRECONDITION error is returned.
  &quot;force&quot;: True or False, # If set to true, it permits switching to a branch with branch_id even if it has no sufficient active products.
  &quot;note&quot;: &quot;A String&quot;, # Some note on this request, this can be retrieved by CatalogService.GetDefaultBranch before next valid default branch set occurs. This field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}</pre>
</div>

<div class="method">
    <code class="details" id="updateAttributesConfig">updateAttributesConfig(name, body=None, updateMask=None, x__xgafv=None)</code>
  <pre>Updates the AttributesConfig. The catalog attributes in the request will be updated in the catalog, or inserted if they do not exist. Existing catalog attributes not included in the request will remain unchanged. Attributes that are assigned to products, but do not exist at the catalog level, are always included in the response. The product attribute is assigned default values for missing catalog attribute fields, e.g., searchable and dynamic facetable options.

Args:
  name: string, Required. Immutable. The fully qualified resource name of the attribute config. Format: `projects/*/locations/*/catalogs/*/attributesConfig` (required)
  body: object, The request body.
    The object takes the form of:

{ # Catalog level attribute config.
  &quot;attributeConfigLevel&quot;: &quot;A String&quot;, # Output only. The AttributeConfigLevel used for this catalog.
  &quot;catalogAttributes&quot;: { # Enable attribute(s) config at catalog level. For example, indexable, dynamic_facetable, or searchable for each attribute. The key is catalog attribute&#x27;s name. For example: `color`, `brands`, `attributes.custom_attribute`, such as `attributes.xyz`. The maximum number of catalog attributes allowed in a request is 1000.
    &quot;a_key&quot;: { # Catalog level attribute config for an attribute. For example, if customers want to enable/disable facet for a specific attribute.
      &quot;dynamicFacetableOption&quot;: &quot;A String&quot;, # If DYNAMIC_FACETABLE_ENABLED, attribute values are available for dynamic facet. Could only be DYNAMIC_FACETABLE_DISABLED if CatalogAttribute.indexable_option is INDEXABLE_DISABLED. Otherwise, an INVALID_ARGUMENT error is returned. Must be specified, otherwise throws INVALID_FORMAT error.
      &quot;exactSearchableOption&quot;: &quot;A String&quot;, # If EXACT_SEARCHABLE_ENABLED, attribute values will be exact searchable. This property only applies to textual custom attributes and requires indexable set to enabled to enable exact-searchable. If unset, the server behavior defaults to EXACT_SEARCHABLE_DISABLED.
      &quot;facetConfig&quot;: { # Possible options for the facet that corresponds to the current attribute config. # Contains facet options.
        &quot;facetIntervals&quot;: [ # If you don&#x27;t set the facet SearchRequest.FacetSpec.FacetKey.intervals in the request to a numerical attribute, then we use the computed intervals with rounded bounds obtained from all its product numerical attribute values. The computed intervals might not be ideal for some attributes. Therefore, we give you the option to overwrite them with the facet_intervals field. The maximum of facet intervals per CatalogAttribute is 40. Each interval must have a lower bound or an upper bound. If both bounds are provided, then the lower bound must be smaller or equal than the upper bound.
          { # A floating point interval.
            &quot;exclusiveMaximum&quot;: 3.14, # Exclusive upper bound.
            &quot;exclusiveMinimum&quot;: 3.14, # Exclusive lower bound.
            &quot;maximum&quot;: 3.14, # Inclusive upper bound.
            &quot;minimum&quot;: 3.14, # Inclusive lower bound.
          },
        ],
        &quot;ignoredFacetValues&quot;: [ # Each instance represents a list of attribute values to ignore as facet values for a specific time range. The maximum number of instances per CatalogAttribute is 25.
          { # Facet values to ignore on facets during the specified time range for the given SearchResponse.Facet.key attribute.
            &quot;endTime&quot;: &quot;A String&quot;, # If start time is empty and end time is not empty, then ignore these facet values before end time.
            &quot;startTime&quot;: &quot;A String&quot;, # Time range for the current list of facet values to ignore. If multiple time ranges are specified for an facet value for the current attribute, consider all of them. If both are empty, ignore always. If start time and end time are set, then start time must be before end time. If start time is not empty and end time is empty, then will ignore these facet values after the start time.
            &quot;values&quot;: [ # List of facet values to ignore for the following time range. The facet values are the same as the attribute values. There is a limit of 10 values per instance of IgnoredFacetValues. Each value can have at most 128 characters.
              &quot;A String&quot;,
            ],
          },
        ],
        &quot;mergedFacet&quot;: { # The current facet key (i.e. attribute config) maps into the merged_facet_key. A facet key can have at most one child. The current facet key and the merged facet key need both to be textual custom attributes or both numerical custom attributes (same type). # Use this field only if you want to merge a facet key into another facet key.
          &quot;mergedFacetKey&quot;: &quot;A String&quot;, # The merged facet key should be a valid facet key that is different than the facet key of the current catalog attribute. We refer this is merged facet key as the child of the current catalog attribute. This merged facet key can&#x27;t be a parent of another facet key (i.e. no directed path of length 2). This merged facet key needs to be either a textual custom attribute or a numerical custom attribute.
        },
        &quot;mergedFacetValues&quot;: [ # Each instance replaces a list of facet values by a merged facet value. If a facet value is not in any list, then it will stay the same. To avoid conflicts, only paths of length 1 are accepted. In other words, if &quot;dark_blue&quot; merged into &quot;BLUE&quot;, then the latter can&#x27;t merge into &quot;blues&quot; because this would create a path of length 2. The maximum number of instances of MergedFacetValue per CatalogAttribute is 100. This feature is available only for textual custom attributes.
          { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes.
            &quot;mergedValue&quot;: &quot;A String&quot;, # All the previous values are replaced by this merged facet value. This merged_value must be non-empty and can have up to 128 characters.
            &quot;values&quot;: [ # All the facet values that are replaces by the same merged_value that follows. The maximum number of values per MergedFacetValue is 25. Each value can have up to 128 characters.
              &quot;A String&quot;,
            ],
          },
        ],
        &quot;rerankConfig&quot;: { # Options to rerank based on facet values engaged by the user for the current key. That key needs to be a custom textual key and facetable. To use this control, you also need to pass all the facet keys engaged by the user in the request using the field [SearchRequest.FacetSpec]. In particular, if you don&#x27;t pass the facet keys engaged that you want to rerank on, this control won&#x27;t be effective. Moreover, to obtain better results, the facet values that you want to rerank on should be close to English (ideally made of words, underscores, and spaces). # Set this field only if you want to rerank based on facet values engaged by the user for the current key. This option is only possible for custom facetable textual keys.
          &quot;facetValues&quot;: [ # If empty, rerank on all facet values for the current key. Otherwise, will rerank on the facet values from this list only.
            &quot;A String&quot;,
          ],
          &quot;rerankFacet&quot;: True or False, # If set to true, then we also rerank the dynamic facets based on the facet values engaged by the user for the current attribute key during serving.
        },
      },
      &quot;inUse&quot;: True or False, # Output only. Indicates whether this attribute has been used by any products. `True` if at least one Product is using this attribute in Product.attributes. Otherwise, this field is `False`. CatalogAttribute can be pre-loaded by using CatalogService.AddCatalogAttribute or CatalogService.UpdateAttributesConfig APIs. This field is `False` for pre-loaded CatalogAttributes. Only pre-loaded catalog attributes that are neither in use by products nor predefined can be deleted. Catalog attributes that are either in use by products or are predefined attributes cannot be deleted; however, their configuration properties will reset to default values upon removal request. After catalog changes, it takes about 10 minutes for this field to update.
      &quot;indexableOption&quot;: &quot;A String&quot;, # When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if INDEXABLE_ENABLED attribute values are indexed so that it can be filtered, faceted, or boosted in SearchService.Search. Must be specified when AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, otherwise throws INVALID_FORMAT error.
      &quot;key&quot;: &quot;A String&quot;, # Required. Attribute name. For example: `color`, `brands`, `attributes.custom_attribute`, such as `attributes.xyz`. To be indexable, the attribute name can contain only alpha-numeric characters and underscores. For example, an attribute named `attributes.abc_xyz` can be indexed, but an attribute named `attributes.abc-xyz` cannot be indexed. If the attribute key starts with `attributes.`, then the attribute is a custom attribute. Attributes such as `brands`, `patterns`, and `title` are built-in and called system attributes.
      &quot;recommendationsFilteringOption&quot;: &quot;A String&quot;, # When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if RECOMMENDATIONS_FILTERING_ENABLED, attribute values are filterable for recommendations. This option works for categorical features only, does not work for numerical features, inventory filtering.
      &quot;retrievableOption&quot;: &quot;A String&quot;, # If RETRIEVABLE_ENABLED, attribute values are retrievable in the search results. If unset, the server behavior defaults to RETRIEVABLE_DISABLED.
      &quot;searchableOption&quot;: &quot;A String&quot;, # When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if SEARCHABLE_ENABLED, attribute values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but attribute type is numerical, attribute values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical attributes. Must be specified, when AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, otherwise throws INVALID_FORMAT error.
      &quot;type&quot;: &quot;A String&quot;, # Output only. The type of this attribute. This is derived from the attribute in Product.attributes.
    },
  },
  &quot;name&quot;: &quot;A String&quot;, # Required. Immutable. The fully qualified resource name of the attribute config. Format: `projects/*/locations/*/catalogs/*/attributesConfig`
}

  updateMask: string, Indicates which fields in the provided AttributesConfig to update. The following is the only supported field: * AttributesConfig.catalog_attributes If not set, all supported fields are updated.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Catalog level attribute config.
  &quot;attributeConfigLevel&quot;: &quot;A String&quot;, # Output only. The AttributeConfigLevel used for this catalog.
  &quot;catalogAttributes&quot;: { # Enable attribute(s) config at catalog level. For example, indexable, dynamic_facetable, or searchable for each attribute. The key is catalog attribute&#x27;s name. For example: `color`, `brands`, `attributes.custom_attribute`, such as `attributes.xyz`. The maximum number of catalog attributes allowed in a request is 1000.
    &quot;a_key&quot;: { # Catalog level attribute config for an attribute. For example, if customers want to enable/disable facet for a specific attribute.
      &quot;dynamicFacetableOption&quot;: &quot;A String&quot;, # If DYNAMIC_FACETABLE_ENABLED, attribute values are available for dynamic facet. Could only be DYNAMIC_FACETABLE_DISABLED if CatalogAttribute.indexable_option is INDEXABLE_DISABLED. Otherwise, an INVALID_ARGUMENT error is returned. Must be specified, otherwise throws INVALID_FORMAT error.
      &quot;exactSearchableOption&quot;: &quot;A String&quot;, # If EXACT_SEARCHABLE_ENABLED, attribute values will be exact searchable. This property only applies to textual custom attributes and requires indexable set to enabled to enable exact-searchable. If unset, the server behavior defaults to EXACT_SEARCHABLE_DISABLED.
      &quot;facetConfig&quot;: { # Possible options for the facet that corresponds to the current attribute config. # Contains facet options.
        &quot;facetIntervals&quot;: [ # If you don&#x27;t set the facet SearchRequest.FacetSpec.FacetKey.intervals in the request to a numerical attribute, then we use the computed intervals with rounded bounds obtained from all its product numerical attribute values. The computed intervals might not be ideal for some attributes. Therefore, we give you the option to overwrite them with the facet_intervals field. The maximum of facet intervals per CatalogAttribute is 40. Each interval must have a lower bound or an upper bound. If both bounds are provided, then the lower bound must be smaller or equal than the upper bound.
          { # A floating point interval.
            &quot;exclusiveMaximum&quot;: 3.14, # Exclusive upper bound.
            &quot;exclusiveMinimum&quot;: 3.14, # Exclusive lower bound.
            &quot;maximum&quot;: 3.14, # Inclusive upper bound.
            &quot;minimum&quot;: 3.14, # Inclusive lower bound.
          },
        ],
        &quot;ignoredFacetValues&quot;: [ # Each instance represents a list of attribute values to ignore as facet values for a specific time range. The maximum number of instances per CatalogAttribute is 25.
          { # Facet values to ignore on facets during the specified time range for the given SearchResponse.Facet.key attribute.
            &quot;endTime&quot;: &quot;A String&quot;, # If start time is empty and end time is not empty, then ignore these facet values before end time.
            &quot;startTime&quot;: &quot;A String&quot;, # Time range for the current list of facet values to ignore. If multiple time ranges are specified for an facet value for the current attribute, consider all of them. If both are empty, ignore always. If start time and end time are set, then start time must be before end time. If start time is not empty and end time is empty, then will ignore these facet values after the start time.
            &quot;values&quot;: [ # List of facet values to ignore for the following time range. The facet values are the same as the attribute values. There is a limit of 10 values per instance of IgnoredFacetValues. Each value can have at most 128 characters.
              &quot;A String&quot;,
            ],
          },
        ],
        &quot;mergedFacet&quot;: { # The current facet key (i.e. attribute config) maps into the merged_facet_key. A facet key can have at most one child. The current facet key and the merged facet key need both to be textual custom attributes or both numerical custom attributes (same type). # Use this field only if you want to merge a facet key into another facet key.
          &quot;mergedFacetKey&quot;: &quot;A String&quot;, # The merged facet key should be a valid facet key that is different than the facet key of the current catalog attribute. We refer this is merged facet key as the child of the current catalog attribute. This merged facet key can&#x27;t be a parent of another facet key (i.e. no directed path of length 2). This merged facet key needs to be either a textual custom attribute or a numerical custom attribute.
        },
        &quot;mergedFacetValues&quot;: [ # Each instance replaces a list of facet values by a merged facet value. If a facet value is not in any list, then it will stay the same. To avoid conflicts, only paths of length 1 are accepted. In other words, if &quot;dark_blue&quot; merged into &quot;BLUE&quot;, then the latter can&#x27;t merge into &quot;blues&quot; because this would create a path of length 2. The maximum number of instances of MergedFacetValue per CatalogAttribute is 100. This feature is available only for textual custom attributes.
          { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes.
            &quot;mergedValue&quot;: &quot;A String&quot;, # All the previous values are replaced by this merged facet value. This merged_value must be non-empty and can have up to 128 characters.
            &quot;values&quot;: [ # All the facet values that are replaces by the same merged_value that follows. The maximum number of values per MergedFacetValue is 25. Each value can have up to 128 characters.
              &quot;A String&quot;,
            ],
          },
        ],
        &quot;rerankConfig&quot;: { # Options to rerank based on facet values engaged by the user for the current key. That key needs to be a custom textual key and facetable. To use this control, you also need to pass all the facet keys engaged by the user in the request using the field [SearchRequest.FacetSpec]. In particular, if you don&#x27;t pass the facet keys engaged that you want to rerank on, this control won&#x27;t be effective. Moreover, to obtain better results, the facet values that you want to rerank on should be close to English (ideally made of words, underscores, and spaces). # Set this field only if you want to rerank based on facet values engaged by the user for the current key. This option is only possible for custom facetable textual keys.
          &quot;facetValues&quot;: [ # If empty, rerank on all facet values for the current key. Otherwise, will rerank on the facet values from this list only.
            &quot;A String&quot;,
          ],
          &quot;rerankFacet&quot;: True or False, # If set to true, then we also rerank the dynamic facets based on the facet values engaged by the user for the current attribute key during serving.
        },
      },
      &quot;inUse&quot;: True or False, # Output only. Indicates whether this attribute has been used by any products. `True` if at least one Product is using this attribute in Product.attributes. Otherwise, this field is `False`. CatalogAttribute can be pre-loaded by using CatalogService.AddCatalogAttribute or CatalogService.UpdateAttributesConfig APIs. This field is `False` for pre-loaded CatalogAttributes. Only pre-loaded catalog attributes that are neither in use by products nor predefined can be deleted. Catalog attributes that are either in use by products or are predefined attributes cannot be deleted; however, their configuration properties will reset to default values upon removal request. After catalog changes, it takes about 10 minutes for this field to update.
      &quot;indexableOption&quot;: &quot;A String&quot;, # When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if INDEXABLE_ENABLED attribute values are indexed so that it can be filtered, faceted, or boosted in SearchService.Search. Must be specified when AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, otherwise throws INVALID_FORMAT error.
      &quot;key&quot;: &quot;A String&quot;, # Required. Attribute name. For example: `color`, `brands`, `attributes.custom_attribute`, such as `attributes.xyz`. To be indexable, the attribute name can contain only alpha-numeric characters and underscores. For example, an attribute named `attributes.abc_xyz` can be indexed, but an attribute named `attributes.abc-xyz` cannot be indexed. If the attribute key starts with `attributes.`, then the attribute is a custom attribute. Attributes such as `brands`, `patterns`, and `title` are built-in and called system attributes.
      &quot;recommendationsFilteringOption&quot;: &quot;A String&quot;, # When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if RECOMMENDATIONS_FILTERING_ENABLED, attribute values are filterable for recommendations. This option works for categorical features only, does not work for numerical features, inventory filtering.
      &quot;retrievableOption&quot;: &quot;A String&quot;, # If RETRIEVABLE_ENABLED, attribute values are retrievable in the search results. If unset, the server behavior defaults to RETRIEVABLE_DISABLED.
      &quot;searchableOption&quot;: &quot;A String&quot;, # When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if SEARCHABLE_ENABLED, attribute values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but attribute type is numerical, attribute values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical attributes. Must be specified, when AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, otherwise throws INVALID_FORMAT error.
      &quot;type&quot;: &quot;A String&quot;, # Output only. The type of this attribute. This is derived from the attribute in Product.attributes.
    },
  },
  &quot;name&quot;: &quot;A String&quot;, # Required. Immutable. The fully qualified resource name of the attribute config. Format: `projects/*/locations/*/catalogs/*/attributesConfig`
}</pre>
</div>

<div class="method">
    <code class="details" id="updateCompletionConfig">updateCompletionConfig(name, body=None, updateMask=None, x__xgafv=None)</code>
  <pre>Updates the CompletionConfigs.

Args:
  name: string, Required. Immutable. Fully qualified name `projects/*/locations/*/catalogs/*/completionConfig` (required)
  body: object, The request body.
    The object takes the form of:

{ # Catalog level autocomplete config for customers to customize autocomplete feature&#x27;s settings.
  &quot;allowlistInputConfig&quot;: { # The input config source for completion data. # Output only. The source data for the latest import of the autocomplete allowlist phrases.
    &quot;bigQuerySource&quot;: { # BigQuery source import data from. # Required. BigQuery input source. Add the IAM permission &quot;BigQuery Data Viewer&quot; for cloud-retail-customer-data-access@system.gserviceaccount.com before using this feature otherwise an error is thrown.
      &quot;dataSchema&quot;: &quot;A String&quot;, # The schema to use when parsing the data from the source. Supported values for product imports: * `product` (default): One JSON Product per line. Each product must have a valid Product.id. * `product_merchant_center`: See [Importing catalog data from Merchant Center](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mc). Supported values for user events imports: * `user_event` (default): One JSON UserEvent per line. * `user_event_ga360`: The schema is available here: https://support.google.com/analytics/answer/3437719. * `user_event_ga4`: The schema is available here: https://support.google.com/analytics/answer/7029846. Supported values for autocomplete imports: * `suggestions` (default): One JSON completion suggestion per line. * `denylist`: One JSON deny suggestion per line. * `allowlist`: One JSON allow suggestion per line.
      &quot;datasetId&quot;: &quot;A String&quot;, # Required. The BigQuery data set to copy the data from with a length limit of 1,024 characters.
      &quot;gcsStagingDir&quot;: &quot;A String&quot;, # Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the BigQuery export to a specific Cloud Storage directory.
      &quot;partitionDate&quot;: { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # BigQuery time partitioned table&#x27;s _PARTITIONDATE in YYYY-MM-DD format.
        &quot;day&quot;: 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn&#x27;t significant.
        &quot;month&quot;: 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
        &quot;year&quot;: 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
      },
      &quot;projectId&quot;: &quot;A String&quot;, # The project ID (can be project # or ID) that the BigQuery source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.
      &quot;tableId&quot;: &quot;A String&quot;, # Required. The BigQuery table to copy the data from with a length limit of 1,024 characters.
    },
  },
  &quot;autoLearning&quot;: True or False, # If set to true, the auto learning function is enabled. Auto learning uses user data to generate suggestions using ML techniques. Default value is false. Only after enabling auto learning can users use `cloud-retail` data in CompleteQueryRequest.
  &quot;denylistInputConfig&quot;: { # The input config source for completion data. # Output only. The source data for the latest import of the autocomplete denylist phrases.
    &quot;bigQuerySource&quot;: { # BigQuery source import data from. # Required. BigQuery input source. Add the IAM permission &quot;BigQuery Data Viewer&quot; for cloud-retail-customer-data-access@system.gserviceaccount.com before using this feature otherwise an error is thrown.
      &quot;dataSchema&quot;: &quot;A String&quot;, # The schema to use when parsing the data from the source. Supported values for product imports: * `product` (default): One JSON Product per line. Each product must have a valid Product.id. * `product_merchant_center`: See [Importing catalog data from Merchant Center](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mc). Supported values for user events imports: * `user_event` (default): One JSON UserEvent per line. * `user_event_ga360`: The schema is available here: https://support.google.com/analytics/answer/3437719. * `user_event_ga4`: The schema is available here: https://support.google.com/analytics/answer/7029846. Supported values for autocomplete imports: * `suggestions` (default): One JSON completion suggestion per line. * `denylist`: One JSON deny suggestion per line. * `allowlist`: One JSON allow suggestion per line.
      &quot;datasetId&quot;: &quot;A String&quot;, # Required. The BigQuery data set to copy the data from with a length limit of 1,024 characters.
      &quot;gcsStagingDir&quot;: &quot;A String&quot;, # Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the BigQuery export to a specific Cloud Storage directory.
      &quot;partitionDate&quot;: { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # BigQuery time partitioned table&#x27;s _PARTITIONDATE in YYYY-MM-DD format.
        &quot;day&quot;: 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn&#x27;t significant.
        &quot;month&quot;: 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
        &quot;year&quot;: 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
      },
      &quot;projectId&quot;: &quot;A String&quot;, # The project ID (can be project # or ID) that the BigQuery source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.
      &quot;tableId&quot;: &quot;A String&quot;, # Required. The BigQuery table to copy the data from with a length limit of 1,024 characters.
    },
  },
  &quot;lastAllowlistImportOperation&quot;: &quot;A String&quot;, # Output only. Name of the LRO corresponding to the latest allowlist import. Can use GetOperation API to retrieve the latest state of the Long Running Operation.
  &quot;lastDenylistImportOperation&quot;: &quot;A String&quot;, # Output only. Name of the LRO corresponding to the latest denylist import. Can use GetOperation API to retrieve the latest state of the Long Running Operation.
  &quot;lastSuggestionsImportOperation&quot;: &quot;A String&quot;, # Output only. Name of the LRO corresponding to the latest suggestion terms list import. Can use GetOperation API method to retrieve the latest state of the Long Running Operation.
  &quot;matchingOrder&quot;: &quot;A String&quot;, # Specifies the matching order for autocomplete suggestions, e.g., a query consisting of &#x27;sh&#x27; with &#x27;out-of-order&#x27; specified would suggest &quot;women&#x27;s shoes&quot;, whereas a query of &#x27;red s&#x27; with &#x27;exact-prefix&#x27; specified would suggest &quot;red shoes&quot;. Currently supported values: * &#x27;out-of-order&#x27; * &#x27;exact-prefix&#x27; Default value: &#x27;exact-prefix&#x27;.
  &quot;maxSuggestions&quot;: 42, # The maximum number of autocomplete suggestions returned per term. Default value is 20. If left unset or set to 0, then will fallback to default value. Value range is 1 to 20.
  &quot;minPrefixLength&quot;: 42, # The minimum number of characters needed to be typed in order to get suggestions. Default value is 2. If left unset or set to 0, then will fallback to default value. Value range is 1 to 20.
  &quot;name&quot;: &quot;A String&quot;, # Required. Immutable. Fully qualified name `projects/*/locations/*/catalogs/*/completionConfig`
  &quot;suggestionsInputConfig&quot;: { # The input config source for completion data. # Output only. The source data for the latest import of the autocomplete suggestion phrases.
    &quot;bigQuerySource&quot;: { # BigQuery source import data from. # Required. BigQuery input source. Add the IAM permission &quot;BigQuery Data Viewer&quot; for cloud-retail-customer-data-access@system.gserviceaccount.com before using this feature otherwise an error is thrown.
      &quot;dataSchema&quot;: &quot;A String&quot;, # The schema to use when parsing the data from the source. Supported values for product imports: * `product` (default): One JSON Product per line. Each product must have a valid Product.id. * `product_merchant_center`: See [Importing catalog data from Merchant Center](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mc). Supported values for user events imports: * `user_event` (default): One JSON UserEvent per line. * `user_event_ga360`: The schema is available here: https://support.google.com/analytics/answer/3437719. * `user_event_ga4`: The schema is available here: https://support.google.com/analytics/answer/7029846. Supported values for autocomplete imports: * `suggestions` (default): One JSON completion suggestion per line. * `denylist`: One JSON deny suggestion per line. * `allowlist`: One JSON allow suggestion per line.
      &quot;datasetId&quot;: &quot;A String&quot;, # Required. The BigQuery data set to copy the data from with a length limit of 1,024 characters.
      &quot;gcsStagingDir&quot;: &quot;A String&quot;, # Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the BigQuery export to a specific Cloud Storage directory.
      &quot;partitionDate&quot;: { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # BigQuery time partitioned table&#x27;s _PARTITIONDATE in YYYY-MM-DD format.
        &quot;day&quot;: 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn&#x27;t significant.
        &quot;month&quot;: 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
        &quot;year&quot;: 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
      },
      &quot;projectId&quot;: &quot;A String&quot;, # The project ID (can be project # or ID) that the BigQuery source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.
      &quot;tableId&quot;: &quot;A String&quot;, # Required. The BigQuery table to copy the data from with a length limit of 1,024 characters.
    },
  },
}

  updateMask: string, Indicates which fields in the provided CompletionConfig to update. The following are the only supported fields: * CompletionConfig.matching_order * CompletionConfig.max_suggestions * CompletionConfig.min_prefix_length * CompletionConfig.auto_learning If not set, all supported fields are updated.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Catalog level autocomplete config for customers to customize autocomplete feature&#x27;s settings.
  &quot;allowlistInputConfig&quot;: { # The input config source for completion data. # Output only. The source data for the latest import of the autocomplete allowlist phrases.
    &quot;bigQuerySource&quot;: { # BigQuery source import data from. # Required. BigQuery input source. Add the IAM permission &quot;BigQuery Data Viewer&quot; for cloud-retail-customer-data-access@system.gserviceaccount.com before using this feature otherwise an error is thrown.
      &quot;dataSchema&quot;: &quot;A String&quot;, # The schema to use when parsing the data from the source. Supported values for product imports: * `product` (default): One JSON Product per line. Each product must have a valid Product.id. * `product_merchant_center`: See [Importing catalog data from Merchant Center](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mc). Supported values for user events imports: * `user_event` (default): One JSON UserEvent per line. * `user_event_ga360`: The schema is available here: https://support.google.com/analytics/answer/3437719. * `user_event_ga4`: The schema is available here: https://support.google.com/analytics/answer/7029846. Supported values for autocomplete imports: * `suggestions` (default): One JSON completion suggestion per line. * `denylist`: One JSON deny suggestion per line. * `allowlist`: One JSON allow suggestion per line.
      &quot;datasetId&quot;: &quot;A String&quot;, # Required. The BigQuery data set to copy the data from with a length limit of 1,024 characters.
      &quot;gcsStagingDir&quot;: &quot;A String&quot;, # Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the BigQuery export to a specific Cloud Storage directory.
      &quot;partitionDate&quot;: { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # BigQuery time partitioned table&#x27;s _PARTITIONDATE in YYYY-MM-DD format.
        &quot;day&quot;: 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn&#x27;t significant.
        &quot;month&quot;: 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
        &quot;year&quot;: 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
      },
      &quot;projectId&quot;: &quot;A String&quot;, # The project ID (can be project # or ID) that the BigQuery source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.
      &quot;tableId&quot;: &quot;A String&quot;, # Required. The BigQuery table to copy the data from with a length limit of 1,024 characters.
    },
  },
  &quot;autoLearning&quot;: True or False, # If set to true, the auto learning function is enabled. Auto learning uses user data to generate suggestions using ML techniques. Default value is false. Only after enabling auto learning can users use `cloud-retail` data in CompleteQueryRequest.
  &quot;denylistInputConfig&quot;: { # The input config source for completion data. # Output only. The source data for the latest import of the autocomplete denylist phrases.
    &quot;bigQuerySource&quot;: { # BigQuery source import data from. # Required. BigQuery input source. Add the IAM permission &quot;BigQuery Data Viewer&quot; for cloud-retail-customer-data-access@system.gserviceaccount.com before using this feature otherwise an error is thrown.
      &quot;dataSchema&quot;: &quot;A String&quot;, # The schema to use when parsing the data from the source. Supported values for product imports: * `product` (default): One JSON Product per line. Each product must have a valid Product.id. * `product_merchant_center`: See [Importing catalog data from Merchant Center](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mc). Supported values for user events imports: * `user_event` (default): One JSON UserEvent per line. * `user_event_ga360`: The schema is available here: https://support.google.com/analytics/answer/3437719. * `user_event_ga4`: The schema is available here: https://support.google.com/analytics/answer/7029846. Supported values for autocomplete imports: * `suggestions` (default): One JSON completion suggestion per line. * `denylist`: One JSON deny suggestion per line. * `allowlist`: One JSON allow suggestion per line.
      &quot;datasetId&quot;: &quot;A String&quot;, # Required. The BigQuery data set to copy the data from with a length limit of 1,024 characters.
      &quot;gcsStagingDir&quot;: &quot;A String&quot;, # Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the BigQuery export to a specific Cloud Storage directory.
      &quot;partitionDate&quot;: { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # BigQuery time partitioned table&#x27;s _PARTITIONDATE in YYYY-MM-DD format.
        &quot;day&quot;: 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn&#x27;t significant.
        &quot;month&quot;: 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
        &quot;year&quot;: 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
      },
      &quot;projectId&quot;: &quot;A String&quot;, # The project ID (can be project # or ID) that the BigQuery source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.
      &quot;tableId&quot;: &quot;A String&quot;, # Required. The BigQuery table to copy the data from with a length limit of 1,024 characters.
    },
  },
  &quot;lastAllowlistImportOperation&quot;: &quot;A String&quot;, # Output only. Name of the LRO corresponding to the latest allowlist import. Can use GetOperation API to retrieve the latest state of the Long Running Operation.
  &quot;lastDenylistImportOperation&quot;: &quot;A String&quot;, # Output only. Name of the LRO corresponding to the latest denylist import. Can use GetOperation API to retrieve the latest state of the Long Running Operation.
  &quot;lastSuggestionsImportOperation&quot;: &quot;A String&quot;, # Output only. Name of the LRO corresponding to the latest suggestion terms list import. Can use GetOperation API method to retrieve the latest state of the Long Running Operation.
  &quot;matchingOrder&quot;: &quot;A String&quot;, # Specifies the matching order for autocomplete suggestions, e.g., a query consisting of &#x27;sh&#x27; with &#x27;out-of-order&#x27; specified would suggest &quot;women&#x27;s shoes&quot;, whereas a query of &#x27;red s&#x27; with &#x27;exact-prefix&#x27; specified would suggest &quot;red shoes&quot;. Currently supported values: * &#x27;out-of-order&#x27; * &#x27;exact-prefix&#x27; Default value: &#x27;exact-prefix&#x27;.
  &quot;maxSuggestions&quot;: 42, # The maximum number of autocomplete suggestions returned per term. Default value is 20. If left unset or set to 0, then will fallback to default value. Value range is 1 to 20.
  &quot;minPrefixLength&quot;: 42, # The minimum number of characters needed to be typed in order to get suggestions. Default value is 2. If left unset or set to 0, then will fallback to default value. Value range is 1 to 20.
  &quot;name&quot;: &quot;A String&quot;, # Required. Immutable. Fully qualified name `projects/*/locations/*/catalogs/*/completionConfig`
  &quot;suggestionsInputConfig&quot;: { # The input config source for completion data. # Output only. The source data for the latest import of the autocomplete suggestion phrases.
    &quot;bigQuerySource&quot;: { # BigQuery source import data from. # Required. BigQuery input source. Add the IAM permission &quot;BigQuery Data Viewer&quot; for cloud-retail-customer-data-access@system.gserviceaccount.com before using this feature otherwise an error is thrown.
      &quot;dataSchema&quot;: &quot;A String&quot;, # The schema to use when parsing the data from the source. Supported values for product imports: * `product` (default): One JSON Product per line. Each product must have a valid Product.id. * `product_merchant_center`: See [Importing catalog data from Merchant Center](https://cloud.google.com/retail/recommendations-ai/docs/upload-catalog#mc). Supported values for user events imports: * `user_event` (default): One JSON UserEvent per line. * `user_event_ga360`: The schema is available here: https://support.google.com/analytics/answer/3437719. * `user_event_ga4`: The schema is available here: https://support.google.com/analytics/answer/7029846. Supported values for autocomplete imports: * `suggestions` (default): One JSON completion suggestion per line. * `denylist`: One JSON deny suggestion per line. * `allowlist`: One JSON allow suggestion per line.
      &quot;datasetId&quot;: &quot;A String&quot;, # Required. The BigQuery data set to copy the data from with a length limit of 1,024 characters.
      &quot;gcsStagingDir&quot;: &quot;A String&quot;, # Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the BigQuery export to a specific Cloud Storage directory.
      &quot;partitionDate&quot;: { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # BigQuery time partitioned table&#x27;s _PARTITIONDATE in YYYY-MM-DD format.
        &quot;day&quot;: 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn&#x27;t significant.
        &quot;month&quot;: 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
        &quot;year&quot;: 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
      },
      &quot;projectId&quot;: &quot;A String&quot;, # The project ID (can be project # or ID) that the BigQuery source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.
      &quot;tableId&quot;: &quot;A String&quot;, # Required. The BigQuery table to copy the data from with a length limit of 1,024 characters.
    },
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="updateConversationalSearchCustomizationConfig">updateConversationalSearchCustomizationConfig(catalog, body=None, updateMask=None, x__xgafv=None)</code>
  <pre>Updates the conversational search customization config for a given catalog.

Args:
  catalog: string, Required. Resource name of the catalog. Format: projects/{project}/locations/{location}/catalogs/{catalog} (required)
  body: object, The request body.
    The object takes the form of:

{ # The public proto to represent the conversational search customization config. It will be converted to the internal proto in the backend.
  &quot;catalog&quot;: &quot;A String&quot;, # Required. Resource name of the catalog. Format: projects/{project}/locations/{location}/catalogs/{catalog}
  &quot;intentClassificationConfig&quot;: { # The public proto to represent the intent classification config. It will be converted to the internal proto in the backend. # Optional. The configs for intent classification.
    &quot;blocklistKeywords&quot;: [ # Optional. A list of keywords that will be used to classify the query to the &quot;BLOCKLISTED&quot; intent type. The keywords are case insensitive.
      &quot;A String&quot;,
    ],
    &quot;disabledIntentTypes&quot;: [ # Optional. A list of intent types that will be disabled for this customer. The intent types must match one of the predefined intent types defined at https://cloud.google.com/retail/docs/reference/rpc/google.cloud.retail.v2alpha#querytype
      &quot;A String&quot;,
    ],
    &quot;example&quot;: [ # Optional. A list of examples for intent classification.
      { # An example for intent classification.
        &quot;classifiedPositive&quot;: True or False, # Required. Whether the example is classified positively.
        &quot;intentType&quot;: &quot;A String&quot;, # Optional. The intent_type must match one of the predefined intent types defined at https://cloud.google.com/retail/docs/reference/rpc/google.cloud.retail.v2alpha#querytype
        &quot;query&quot;: &quot;A String&quot;, # Required. Example query.
        &quot;reason&quot;: &quot;A String&quot;, # Optional. The reason for the intent classification. This is used to explain the intent classification decision.
      },
    ],
    &quot;inlineSource&quot;: { # Inline source for intent classifications. # Optional. Inline source for intent classifications.
      &quot;inlineForceIntents&quot;: [ # Optional. A list of inline force intent classifications.
        { # An inline force intent classification configuration.
          &quot;intentType&quot;: &quot;A String&quot;, # Optional. The intent_type must match one of the predefined intent types defined at https://cloud.google.com/retail/docs/reference/rpc/google.cloud.retail.v2alpha#querytype
          &quot;operation&quot;: &quot;A String&quot;, # Optional. The operation to perform for the query.
          &quot;query&quot;: &quot;A String&quot;, # Optional. A example query.
        },
      ],
    },
    &quot;modelPreamble&quot;: &quot;A String&quot;, # Optional. Customers can use the preamble to specify any requirements for blocklisting intent classification. This preamble will be added to the blocklisting intent classification model prompt.
  },
  &quot;retailerDisplayName&quot;: &quot;A String&quot;, # Optional. The retailer&#x27;s display name that could be used in our LLM answers. Example - &quot;Google&quot;
}

  updateMask: string, Optional. Indicates which fields in the provided ConversationalSearchCustomizationConfig to update. If not set or empty, all supported fields are updated.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The public proto to represent the conversational search customization config. It will be converted to the internal proto in the backend.
  &quot;catalog&quot;: &quot;A String&quot;, # Required. Resource name of the catalog. Format: projects/{project}/locations/{location}/catalogs/{catalog}
  &quot;intentClassificationConfig&quot;: { # The public proto to represent the intent classification config. It will be converted to the internal proto in the backend. # Optional. The configs for intent classification.
    &quot;blocklistKeywords&quot;: [ # Optional. A list of keywords that will be used to classify the query to the &quot;BLOCKLISTED&quot; intent type. The keywords are case insensitive.
      &quot;A String&quot;,
    ],
    &quot;disabledIntentTypes&quot;: [ # Optional. A list of intent types that will be disabled for this customer. The intent types must match one of the predefined intent types defined at https://cloud.google.com/retail/docs/reference/rpc/google.cloud.retail.v2alpha#querytype
      &quot;A String&quot;,
    ],
    &quot;example&quot;: [ # Optional. A list of examples for intent classification.
      { # An example for intent classification.
        &quot;classifiedPositive&quot;: True or False, # Required. Whether the example is classified positively.
        &quot;intentType&quot;: &quot;A String&quot;, # Optional. The intent_type must match one of the predefined intent types defined at https://cloud.google.com/retail/docs/reference/rpc/google.cloud.retail.v2alpha#querytype
        &quot;query&quot;: &quot;A String&quot;, # Required. Example query.
        &quot;reason&quot;: &quot;A String&quot;, # Optional. The reason for the intent classification. This is used to explain the intent classification decision.
      },
    ],
    &quot;inlineSource&quot;: { # Inline source for intent classifications. # Optional. Inline source for intent classifications.
      &quot;inlineForceIntents&quot;: [ # Optional. A list of inline force intent classifications.
        { # An inline force intent classification configuration.
          &quot;intentType&quot;: &quot;A String&quot;, # Optional. The intent_type must match one of the predefined intent types defined at https://cloud.google.com/retail/docs/reference/rpc/google.cloud.retail.v2alpha#querytype
          &quot;operation&quot;: &quot;A String&quot;, # Optional. The operation to perform for the query.
          &quot;query&quot;: &quot;A String&quot;, # Optional. A example query.
        },
      ],
    },
    &quot;modelPreamble&quot;: &quot;A String&quot;, # Optional. Customers can use the preamble to specify any requirements for blocklisting intent classification. This preamble will be added to the blocklisting intent classification model prompt.
  },
  &quot;retailerDisplayName&quot;: &quot;A String&quot;, # Optional. The retailer&#x27;s display name that could be used in our LLM answers. Example - &quot;Google&quot;
}</pre>
</div>

<div class="method">
    <code class="details" id="updateGenerativeQuestion">updateGenerativeQuestion(catalog, body=None, updateMask=None, x__xgafv=None)</code>
  <pre>Allows management of individual questions.

Args:
  catalog: string, Required. Resource name of the catalog. Format: projects/{project}/locations/{location}/catalogs/{catalog} (required)
  body: object, The request body.
    The object takes the form of:

{ # Configuration for a single generated question.
  &quot;allowedInConversation&quot;: True or False, # Optional. Whether the question is asked at serving time.
  &quot;catalog&quot;: &quot;A String&quot;, # Required. Resource name of the catalog. Format: projects/{project}/locations/{location}/catalogs/{catalog}
  &quot;exampleValues&quot;: [ # Output only. Values that can be used to answer the question.
    &quot;A String&quot;,
  ],
  &quot;facet&quot;: &quot;A String&quot;, # Required. The facet to which the question is associated.
  &quot;finalQuestion&quot;: &quot;A String&quot;, # Optional. The question that will be used at serving time. Question can have a max length of 300 bytes. When not populated, generated_question should be used.
  &quot;frequency&quot;: 3.14, # Output only. The ratio of how often a question was asked.
  &quot;generatedQuestion&quot;: &quot;A String&quot;, # Output only. The LLM generated question.
}

  updateMask: string, Optional. Indicates which fields in the provided GenerativeQuestionConfig to update. The following are NOT supported: * GenerativeQuestionConfig.frequency If not set or empty, all supported fields are updated.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Configuration for a single generated question.
  &quot;allowedInConversation&quot;: True or False, # Optional. Whether the question is asked at serving time.
  &quot;catalog&quot;: &quot;A String&quot;, # Required. Resource name of the catalog. Format: projects/{project}/locations/{location}/catalogs/{catalog}
  &quot;exampleValues&quot;: [ # Output only. Values that can be used to answer the question.
    &quot;A String&quot;,
  ],
  &quot;facet&quot;: &quot;A String&quot;, # Required. The facet to which the question is associated.
  &quot;finalQuestion&quot;: &quot;A String&quot;, # Optional. The question that will be used at serving time. Question can have a max length of 300 bytes. When not populated, generated_question should be used.
  &quot;frequency&quot;: 3.14, # Output only. The ratio of how often a question was asked.
  &quot;generatedQuestion&quot;: &quot;A String&quot;, # Output only. The LLM generated question.
}</pre>
</div>

<div class="method">
    <code class="details" id="updateGenerativeQuestionFeature">updateGenerativeQuestionFeature(catalog, body=None, updateMask=None, x__xgafv=None)</code>
  <pre>Manages overal generative question feature state -- enables toggling feature on and off.

Args:
  catalog: string, Required. Resource name of the affected catalog. Format: projects/{project}/locations/{location}/catalogs/{catalog} (required)
  body: object, The request body.
    The object takes the form of:

{ # Configuration for overall generative question feature state.
  &quot;catalog&quot;: &quot;A String&quot;, # Required. Resource name of the affected catalog. Format: projects/{project}/locations/{location}/catalogs/{catalog}
  &quot;featureEnabled&quot;: True or False, # Optional. Determines whether questions will be used at serving time. Note: This feature cannot be enabled until initial data requirements are satisfied.
  &quot;minimumProducts&quot;: 42, # Optional. Minimum number of products in the response to trigger follow-up questions. Value must be 0 or positive.
}

  updateMask: string, Optional. Indicates which fields in the provided GenerativeQuestionsFeatureConfig to update. If not set or empty, all supported fields are updated.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Configuration for overall generative question feature state.
  &quot;catalog&quot;: &quot;A String&quot;, # Required. Resource name of the affected catalog. Format: projects/{project}/locations/{location}/catalogs/{catalog}
  &quot;featureEnabled&quot;: True or False, # Optional. Determines whether questions will be used at serving time. Note: This feature cannot be enabled until initial data requirements are satisfied.
  &quot;minimumProducts&quot;: 42, # Optional. Minimum number of products in the response to trigger follow-up questions. Value must be 0 or positive.
}</pre>
</div>

</body></html>